Datasource

[GET] /api/v2/data/datasources/{id}/download

下载数据源文档。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：05bb029e-0d75-dc4d-671b-87299a4a6907

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[GET] /api/v2/data/datasources/task-status/{taskId}

通过任务id查询数据源任务状态。

参数:

名称	类型	位置	描述
taskId必填项	string	path	任务 ID，前缀为“datasource:”。例如：datasource：a10f7bbc-a416-46e5-ab19-e79e2293a88a

返回值

状态码: 200

成功

WorkerTaskStatusViewModelV2

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[GET] /api/v2/data/datasources/{id}/query

查询数据源。

参数:

名称	类型	位置	描述
id必填项	string	path	数据源ID
query	string	query	查询
queryType	string	query	查询类型
format	string	query	格式
UnknownTypeHandle	string	query	未知类型处理方式
MissParameterHandle	string	query	缺少参数处理方式
RowLimit	string	query	行限制

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[POST] /api/v2/data/datasources/{id}/query

查询数据源。

参数:

名称	类型	位置	描述
id必填项	string	path	数据源ID

请求数据格式

QueryDataSourceRequestBody

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

类型定义

Ƭ DatasetPluginErrorV2

数据集插件错误模型

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	DatasetPluginErrorV2
extendedResult可为空	any	扩展结果

Ƭ WorkerTaskStatusViewModelV2

worker 任务状态视图模型。

名称	类型	描述
taskId可为空	string	任务 ID。
status	WorkerTaskStatusEnumV2
statusText可为空	string	任务状态。
startTime可为空	ISO DateTime Sting	开始时间。
endTime可为空	ISO DateTime Sting	时间结束。
errorMessage可为空	string	错误信息。
errorMessageKey可为空	string	错误消息键。
context可为空	string	上下文。
extraInfo可为空	string	额外信息。

Ƭ WorkerTaskStatusEnumV2

Enum:

Standby
Running
PrimaryTaskFinished
PrimaryTaskFaulted
PrimaryTaskUserCancelled
Finished

任务状态。

* standby - 0 - 待机。
* running - 1 - 正在运行。
* primarytaskfinished - 2 - 主任务已完成。
* primarytaskfaulted - 3 - 主任务发生故障。
* primarytaskusercancelled - 4 - 主任务已被用户取消。
* finished - 7 - 已完成。

Ƭ QueryDataSourceRequestBody

查询数据源请求体

名称	类型	描述
datasourceParameters可为空	string	数据源参数
query可为空	string	查询
queryType可为空	string	查询类型
format可为空	string	格式
options	Options

Ƭ Options

名称	类型	描述
unknownTypeHandle可为空	string	未知类型处理方式
missParameterHandle可为空	string	缺少参数处理方式
rowLimit可为空	string	行限制